package com.zyq.knife4j.config;

import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfig {

    /**【重要】指定Controller包路径*/
    private String basePackage = "com.zyq.knife4j.controller";
    /**分组名称*/
    private String groupName = "zyq-kni4j-demo";
    /**主机名 */
    private String host = "http://java.zyq.cn";
    /**标题 */
    private String title = "zyq-kni4j-demo测试项目在线API文档";
    /**简介*/
    private String description = "zyq-kni4j-demo测试项目在线API文档";
    /**服务条款URL */
    private String termsOfServiceUrl = "http://www.apache.org/licenses/LICENSE-2.0";
    /**联系人*/
    private String contactName = "Java教学研发部";
    /**联系网址*/
    private String contactUrl = "http://java.zyq.cn";
    /**联系邮箱 */
    private String contactEmail = "zhaoYong1230@126.com";
    /**版本号*/
    private String version = "1.0.0";

    @Autowired(required = false)
    private OpenApiExtensionResolver openApiExtensionResolver;

    //配置Swagger2的Docket的Bean实例
    @Bean
    public Docket docket() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .host(host)
                //apiInfo()：配置 API 的一些基本信息，比如：文档标题title，文档描述description，文档版本号version
                .apiInfo(apiInfo())
                //分组名称
                .groupName(groupName)
                // select()：生成 API 文档的选择器，用于指定要生成哪些 API 文档
                .select()
                // apis()：指定要生成哪个包下的 API 文档
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                //paths()：指定要生成哪个 URL 匹配模式下的 API 文档。这里使用PathSelectors.any()，表示生成所有的 API 文档。
                .paths(PathSelectors.any())
                .build()//build()：生成 Docket 实例
                //扩展
                .extensions(   openApiExtensionResolver.buildExtensions(groupName)   );
        return docket;
    }


    //配置Swagger2的ApiInfo的Bean实例(文档标题title，文档描述description，文档版本号version)
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .termsOfServiceUrl(termsOfServiceUrl)//服务条款URL
                //文档联系人(作者)信息
                .contact(new Contact(contactName, contactUrl, contactEmail))
                .version(version)
                .build();
    }

}
